home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / pkins710.zip / PKINSERT.DOC < prev    next >
Text File  |  1992-01-01  |  36KB  |  1,021 lines
  1.  
  2.  
  3.  
  4.  
  5.                    ┌───────────────────────────────────────┐
  6.                    │                                       │
  7.                    │                                       │
  8.                    │                                       │
  9.                    │                                       │
  10.                    │                                       │
  11.                    │                                       │
  12.                    │                                       │
  13.                    │                                       │
  14.                    │                                       │
  15.                    │                                       │
  16.                    │            P K I N S E R T            │
  17.                    │              Version 7.10             │
  18.                    │                                       │
  19.                    │                                       │
  20.                    │   Copyright 7th Illusion, 1990-1992   │
  21.                    │          All Rights Reserved          │
  22.                    │       Released January 1st, 1992      │
  23.                    │                                       │
  24.                    │            F R E E W A R E            │
  25.                    │                                       │
  26.                    │                                       │
  27.                    │                                       │
  28.                    │                                       │
  29.                    │                                       │
  30.                    │                                       │
  31.                    │         Software Documentation        │
  32.                    │                                       │
  33.                    │                                       │
  34.                    │                                       │
  35.                    │                                       │
  36.                    │                                       │
  37.                    │                                       │
  38.                    │                                       │
  39.                    │              7th Illusion             │
  40.                    │        P.O. Box 1334, Station H       │
  41.                    │          Montreal QC, Canada          │
  42.                    │                H3G 2N6                │
  43.                    │                                       │
  44.                    │                                       │
  45.                    │                                       │
  46.                    │                                       │
  47.                    │     Node 1 (514)338-1193 14400 Bps    │
  48.                    │     Node 2 (514)338-1680  2400 Bps    │
  49.                    │                                       │
  50.                    │        1:167/281.0@fidonet.org        │
  51.                    │                                       │
  52.                    │                                       │
  53.                    │                                       │
  54.                    │                                       │
  55.                    │                                       │
  56.                    │                                       │
  57.                    │                                       │
  58.                    └───────────────────────────────────────┘
  59.  
  60.      
  61.  
  62.      PKInsert Software Documentation                          Page 1  of 16
  63.      ──────────────────────────────────────────────────────────────────────
  64.  
  65.                                   Introduction
  66.  
  67.      PKInsert is an archive manipulation  utility.  It may be configured to
  68.      test  archive  integrity, scan  for  virii, insert  and/or  delete BBS
  69.      disclaimers/Ads, and  throw in archive  comments.  Zip,  Lzh, Arj, and
  70.      Arj-Sfx type archives are all fully supported.
  71.  
  72.      You'll  find  an  abundance  of  configuration  techniques  available.
  73.      Although many  features will be  especially useful  to PCBoard SysOps,
  74.      I've tried to target  as large a user base  as possible.  I've done my
  75.      best to translate the knowledge I have of PKInsert into this document.
  76.      If however you need further help or have suggestions for improvements,
  77.      don't  hesitate  to  leave  a  message  on  my  system.  Long-distance
  78.      callback  validation is  available and  the  latest version  is always
  79.      posted for download.
  80.  
  81.      PKInsert is the copyrighted property of 7th Illusion Enr., and is made
  82.      available  under  the  "freeware"   concept.   Freeware  products  are
  83.      distributed freely and without charge.
  84.  
  85.      Supplemental  information  on  installing  PKInsert  with  PCBoard  is
  86.      available from the PKInsPCB.Doc file.
  87.  
  88.      PKInsert was written in QuickBASIC  V4.5 on a 386-33mhz IBM Compatible
  89.      running under  DESQview V2.41,  QEMM V6.02,  Microsoft DOS  V3.30, and
  90.      Norton Utilities 5.0 Small Disk Cache.
  91.  
  92.  
  93.               J.S. Morisset aka Storm Widow
  94.               SysOp of 7th Illusion Enr.
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.      
  121.  
  122.      PKInsert Software Documentation                          Page 2  of 16
  123.      ──────────────────────────────────────────────────────────────────────
  124.  
  125.                                 Acknowledgements
  126.  
  127.      The  following  names are  either  trademarks,  registered trademarks,
  128.      and/or efforts of the person and/or company named.
  129.  
  130.      PCBoard            Clark Development Company
  131.      Pkzip/Pkunzip      PKWare Inc.
  132.      Lha                Haruyasu Yoshizaki
  133.      Arj                Robert K. Jung
  134.      SCAN               McAfee Associates
  135.      DESQview/QEMM      Quarterdeck
  136.  
  137.      The terms ARC, ARCHIVE, UNARC,  etc. are used throughout this document
  138.      and are considered GENERIC TERMS FOR ZIP, LZH, AND ARJ ARCHIVE TYPES.
  139.  
  140.                                   Requirements
  141.  
  142.      PKInsert  will  not  load  unless  you  have  the  following  software
  143.      available  from  a PATHed  directory.   The versions  shown  are those
  144.      tested with PKInsert at the time of it's release.
  145.  
  146.      PKZIP/UNZIP.EXE    Version 1.10                  PKZ110.EXE
  147.      LZH.EXE            Version 2.13                  LHA213.EXE
  148.      ARJ.EXE            Version 2.22                  ARJ222.EXE
  149.      SCAN.EXE           Version 8.1V85 (Optional)     SCANV85.ZIP
  150.  
  151.                                    Upgrading
  152.  
  153.      Please  review  the  PKInsert.New  documentation  for  details  on new
  154.      features and bug fixes.
  155.  
  156.      Version 7.00
  157.  
  158.          Simply copy  PKInsert.Exe to  the appropriate  directory.  Version
  159.          7.10 is fully compatible with version 7.00's configuration file.
  160.  
  161.          If you  have a  ramdisk installed, I  suggest you  run the /CONFIG
  162.          module to adjust the new ARJ "Comment Only" parameter.
  163.  
  164.      Version 6.62 and Earlier
  165.  
  166.          Delete all your old configuration  files and follow the directions
  167.          for a new installation.
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.      
  181.  
  182.      PKInsert Software Documentation                          Page 3  of 16
  183.      ──────────────────────────────────────────────────────────────────────
  184.  
  185.                               PKInsert Parameters
  186.  
  187.      PKInsert [Parameters] [@Files.Lst and/or Files.Ext] [Etc.]
  188.  
  189.      Parameters  may  be  entered  from  the  command  line  or environment
  190.      variable.   Environment   parameters  will  over-ride   those  of  the
  191.      configuration file, and  command line parameters  will over-ride those
  192.      of  the environment.   Parameters are  not case  sensitive and  may be
  193.      entered in any order.
  194.  
  195.      /C{FileName.Cfg}
  196.      
  197.          Marks PKInserts configuration  file name and  path.  This variable
  198.          must be present in the environment or command line for PKInsert to
  199.          load successfully.
  200.  
  201.          ie.  /cD:\Arc\PKInsert\PKInsert.Cfg
  202.  
  203.      /D{Describ.Ext}
  204.  
  205.          Pcboard archive description file,  used to document test failures.
  206.          This parameter is passed by PCBoard V14.5a to PCBTest.Bat as (%3).
  207.          (optional).
  208.  
  209.          ie.  /dD:\Pcb\Work\Uldesc.1
  210.               /d%3
  211.  
  212.      /N{Node}
  213.  
  214.          Network  node  number.   Maximum  length  of  three  alpha-numeric
  215.          characters.  This parameter is rarely  needed for a Bulletin Board
  216.          installation.   PKInsert  will  retrieve   the  node  number  from
  217.          Door.Sys and/or PCBoard.Sys files.  (optional).
  218.  
  219.          ie.  /n1A
  220.  
  221.      /S{ScanVer}
  222.  
  223.          Version of  Scan you are  currently using.  Maximum  length of six
  224.          alpha-numeric  characters.   Most  commonly   used  in  a  default
  225.          environment value set within Autoexec.Bat.  (optional).
  226.  
  227.          ie.  /s8.1V85
  228.  
  229.      /CONFIG
  230.  
  231.          Load PKInserts configuration module.
  232.  
  233.          ie.  PKInsert.Exe /cPKInsert.Cfg /Config
  234.  
  235.      /TEST
  236.  
  237.          Re-test an  archive.  Value is  passed by  PCBoard V14.5a Bulletin
  238.          Boards to PCBTest.Bat  as (%2).  Affects  verbose log file results
  239.  
  240.      
  241.  
  242.      PKInsert Software Documentation                          Page 4  of 16
  243.      ──────────────────────────────────────────────────────────────────────
  244.  
  245.          when a virus is located.  (optional).
  246.  
  247.          ie.  PKInsert.Exe /Test Archive.Zip
  248.  
  249.      /UPLOAD
  250.  
  251.          Process an  upload.  Value  is passed  by PCBoard  V14.5a Bulletin
  252.          Boards to PCBTest.Bat  as (%2).  Affects  verbose log file results
  253.          when a virus is located.  (optional).
  254.  
  255.          ie.  PKInsert.Exe /Upload Archive.Zip
  256.  
  257.                               Configuration Module
  258.  
  259.      To configure PKInsert for the first time, follow this first example.
  260.  
  261.          PKInsert.Exe /Config /cC:\PKInsert\PKInsert.Cfg
  262.  
  263.      PKInsert will ask you to verify the path and name of the configuration
  264.      file to create.  Pressing the (Esc) key will get you back to Dos.
  265.  
  266.      From the main configuration menu you will have three choices available
  267.      to you.  We will start from the  first and explain every item as we go
  268.      along.  All standard editing keys are active.
  269.  
  270.      Note:   It is possible to use a single configuration file for multiple
  271.              users/work stations.
  272.  
  273.              Default configuration values may differ based on initial drive
  274.              and directory locations.
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.      
  301.  
  302.      PKInsert Software Documentation                          Page 5  of 16
  303.      ──────────────────────────────────────────────────────────────────────
  304.  
  305.      ╔════════════════════════════════════════════════════════════════════╗
  306.      ║                            Options Menu                            ║
  307.      ║                                                                    ║
  308.      ║   Xtract/Temp Files Drive : C      Insert Archive Comment  : N     ║
  309.      ║   Req Xtract Space (%Arc) : 250    Delete Disclaimer(s)    : N     ║
  310.      ║                                    Add File(s) to Archive  : N     ║
  311.      ║   Rename Bad/Virused Arcs : Y                                      ║
  312.      ║   Held Archive Rename Ext : HLD    Manage Pass/Fail Log    : N     ║
  313.      ║                                    Keep Result/Error Log   : Y     ║
  314.      ║   Test Archive CRC        : Y      Max. Standard Log Size  : 80    ║
  315.      ║   Corrupt Arc Rename Ext  : BAD                                    ║
  316.      ║                                                                    ║
  317.      ║   Scan Archives for Virii : N                                      ║
  318.      ║   Virused Arc Rename Ext  : VIR                                    ║
  319.      ║   McAfee Assoc. SCAN Ver  : 0.0V00                                 ║
  320.      ║                                                                    ║
  321.      ║   Number Taglines to Keep : 10                                     ║
  322.      ║   Identification Tagline?                                          ║
  323.      ║   Generic Tagline                                                  ║
  324.      ║                                                                    ║
  325.      ╚═══ 01/01/92 ════════════════════════════════════════ 07:10:00am ═══╝
  326.  
  327.  
  328.                             Xtract/Temp Files Drive
  329.  
  330.      Enter  the  drive  letter where  PKInsert  will  extract  archives for
  331.      testing and/or  virus scanning.  I  strongly suggest  using a ram-disk
  332.      which improves PKInserts performance dramatically.
  333.  
  334.                             Req Xtract Space (%Arc)
  335.  
  336.      PKInsert  will  check  for  available  disk  space  before  extracting
  337.      archives.   This value  is not  calculated  like tax  - 250%  would be
  338.      translated to 2.5 times the size of the archive.  If PKInsert runs out
  339.      of disk space  during processing, it  will rename the  archive or exit
  340.      with an error level.
  341.  
  342.      Disk space errors are also reported during archive extraction (by most
  343.      archivers), but verifying disk space before-hand saves time.
  344.  
  345.                             Rename Bad/Virused Arcs
  346.  
  347.      Read  this  section  carefully;  this  option  dramatically influences
  348.      PKInserts  internal  and external  behavior.   If archives  are  to be
  349.      processed individually (testing an  upload) I highly recommend setting
  350.      this value to (N)o.
  351.  
  352.      (Y)es Setting
  353.  
  354.          PKInsert will rename archives using  the file extensions you enter
  355.          bellow.   It  is assumed  you  will  be processing  archives  on a
  356.          wildcard (such as *.Arc).  When  encountering a virused or corrupt
  357.          archive, PKinsert  will rename it  and continue to  the next file.
  358.          This  method  is  not  very  selective  -  Any  error  reported by
  359.  
  360.      
  361.  
  362.      PKInsert Software Documentation                          Page 6  of 16
  363.      ──────────────────────────────────────────────────────────────────────
  364.  
  365.          Pkzip/unzip,  Lzh, Arj,  or  Scan will  lead  to an  archive being
  366.          renamed.   These  problems could  be  caused by  a  virus, corrupt
  367.          archive, insufficient disk space, memory, etc.
  368.  
  369.          WHEN  RENAMING  ARCHIVES  PKINSERT  WILL  _ALWAYS_  EXIT  WITH AND
  370.          ERRORLEVEL OF (0) AND PASS/FAIL RESULT LOGING WILL BE DISABLED.
  371.  
  372.      (N)o Setting
  373.  
  374.          On the other hand, if you have elected not to rename archives, you
  375.          can do your own  error checking when PKInsert  exits.  You may use
  376.          errorlevel statements  (in a  batch file)  and/or a  Pass/Fail log
  377.          existence  check.  The  complete list  of  PKInsert exit  codes is
  378.          available in appendix A.
  379.  
  380.          PKINSERT  MUST  EXIT IMMEDIATELY  AFTER  AN ERROR  OCCURS  SO THIS
  381.          OPTION IS NOT RECOMMENDED FOR WILDCARD PROCESSING.
  382.  
  383.                             Held Archive Rename Ext
  384.  
  385.      An archive will  be renamed (if rename  is enabled) to  .Hld if a file
  386.      measures 0  bytes, disk  space runs out,  or the  file is  not a valid
  387.      archive.  This provides a  method to hold archives  which did not fail
  388.      because of Pkzip/unzip, Lzh, Arj, or Scan for later review.
  389.  
  390.                                 Test Archive CRC
  391.  
  392.      Before handling  an archive,  PKInsert calls  Pkunzip, Lzh,  or Arj to
  393.      test the archive's integrity.  Nested  archives (Arcs within Arcs) are
  394.      also tested.
  395.  
  396.      Note:    An  archive may  contain  a maximum  of  4,294,967,295 nested
  397.               archives.  Anything  over that,  and I'm  not responsible for
  398.               the results!  <grin>
  399.  
  400.                              Corrupt Arc Rename Ext
  401.  
  402.      If you choose  to have archives  renamed, PKInsert will  use this file
  403.      extension to rename damaged zips.
  404.  
  405.                             Scan Archives for Virii
  406.  
  407.      PKInsert can use Scan.Exe from McAfee Associates to check archives for
  408.      viral infection.  Although archives are  expanded to check for viruses
  409.      it is unlikely you will 'catch' anything.  Virii which can be archived
  410.      attach themselves to executable code.   The files extracted are Scaned
  411.      and never executed.
  412.  
  413.                              Virused Arc Rename Ext
  414.  
  415.      When  a virus  is detected,  the  archive will  be renamed  using this
  416.      extension (provided renaming is enabled).
  417.  
  418.                              McAfee Assoc. SCAN Ver
  419.  
  420.      
  421.  
  422.      PKInsert Software Documentation                          Page 7  of 16
  423.      ──────────────────────────────────────────────────────────────────────
  424.  
  425.  
  426.      As of this writing the current  version of scan is 8.1V85.  This field
  427.      may be blank or  up to six alpha-numeric  characters.  If you assign a
  428.      value, it will be used in  several display files where mention of Scan
  429.      is  made.  A  command line  or  environment parameter  may be  used to
  430.      over-ride this value.
  431.  
  432.                             Number Taglines to Keep
  433.  
  434.      A  Tagline  is added  to  each archive  comment  containing PKInsert's
  435.      version number and your personalized information.  Taglines from other
  436.      systems may be kept and appended  to your archive comment.  This value
  437.      determines the maximum  number of past  Taglines to keep.   A value of
  438.      zero may be used to disable this feature.
  439.  
  440.      Note:    The  Test,  Scan, or  Delete  functions must  be  enabled for
  441.               PKInsert to pick up past Tagline information.
  442.  
  443.               Only Zip  and Arj type  archives are able  to contain archive
  444.               comments.   This  option,  or  anything  related  to  archive
  445.               comments, will be ignored for Lzh archives.
  446.  
  447.                             Identification Tagline?
  448.  
  449.      Your  personalized Tagline.   Usually this  includes your  BBS's name,
  450.      phone number,  and special  system features.   As the  archive travels
  451.      through various systems,  your tagline will  remain within the archive
  452.      comment (providing other systems keep previous Taglines).
  453.  
  454.      Once a system tagline  has been embedded into  the archive comment, it
  455.      is still possible to  alter it slightly.  PKInsert  does not take into
  456.      account case,  spacing, or  any non  alpha-numeric character.  Adding,
  457.      erasing, or  changing the  positions of  alpha-numeric characters will
  458.      cause your old tagline to be  used in the Tagline history bloc IF/WHEN
  459.      THE ARCHIVE IS RE-PROCESSED.
  460.  
  461.      Note:    A Tagline environment  variable may be  used to over-ride the
  462.               configuration file value.
  463.  
  464.               ie.  SET TAGLINE=7th Illusion /Mainstream Cyberspace/
  465.  
  466.                              Insert Archive Comment
  467.  
  468.      Archives created by Pkzip and Arj give us the opportunity to insert an
  469.      archive comment  screen (Lha does  not support  archive comments).  If
  470.      you  elect   not  to  insert   comments,  THE   ORIGINAL  WILL  REMAIN
  471.      UNDISTURBED.
  472.  
  473.                               Delete Disclaimer(s)
  474.  
  475.      Certain  files,  such  as  !History.Dis  are  well  known  to  contain
  476.      advertisements or  disclaimer blurbs.  You  may elect  to delete these
  477.      files automatically  from each  archive PKInsert  processes.  A sample
  478.      list is included within this package  which you may edit from the next
  479.  
  480.      
  481.  
  482.      PKInsert Software Documentation                          Page 8  of 16
  483.      ──────────────────────────────────────────────────────────────────────
  484.  
  485.      configuration screen.
  486.  
  487.                              Add File(s) to Archive
  488.  
  489.      Same principle  as above,  except this  option lets  you add  files to
  490.      every archive.  I could go on for  hours on the reason not to use this
  491.      feature, including the fact that  you are polluting archives, but I'll
  492.      leave it to your better judgment.
  493.  
  494.                               Manage Pass/Fail Log
  495.  
  496.      Aside from loging results, PKInsert can also create one of two verbose
  497.      log files for every session.  These text files could then be displayed
  498.      to the user.  The names for these files may be specified later on.
  499.  
  500.      Note:    In order to properly link with other utilities which use this
  501.               type of result logging, special handling is necessary.
  502.  
  503.               Before appending a  Failure report, PKInsert  will rename the
  504.               Pass Log (if it  exists) to the Fail  Log name.  Therefore an
  505.               archive could pass a series  of tests before calling PKInsert
  506.               and still keep those results when PKInsert fails the archive.
  507.  
  508.               If an Extended  Fail Log already  exists, it will  be used to
  509.               append  PKInserts  Pass  or Fail  reports.   In  this  way an
  510.               archive could Fail  a series of  tests, pass PKInserts tests,
  511.               and overall you would be left with one Fail log file.
  512.  
  513.                              Keep Result/Error Log
  514.  
  515.      This is a standard log file.  I would suggest you keep this option set
  516.      to (Y)es.  It's maintenance free thanks to the following option.
  517.  
  518.                              Max. Standard Log Size
  519.  
  520.      Before every  session PKInsert  checks the size  of it's  log.  If the
  521.      size exceeds this value (in Kbytes), a new one is started.
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537.  
  538.  
  539.  
  540.      
  541.  
  542.      PKInsert Software Documentation                          Page 9  of 16
  543.      ──────────────────────────────────────────────────────────────────────
  544.  
  545.      ╔════════════════════════════════════════════════════════════════════╗
  546.      ║                         File Location Menu                         ║
  547.      ║                                                                    ║
  548.      ║   Ascii Editor            : C:\QEDIT\Q.EXE                         ║
  549.      ║                                                                    ║
  550.      ║   Standard Log File       : C:\PKINSERT\NODE-#.LOG                 ║
  551.      ║   Extended Pass Log File  : PCBPASS.TXT                            ║
  552.      ║   Extended Fail Log File  : PCBFAIL.TXT                            ║
  553.      ║                                                                    ║
  554.      ║   Virus Comment (Test)    : C:\PKINSERT\VIRUSTST.CMT               ║
  555.      ║   Virus Comment (Upload)  : C:\PKINSERT\VIRUSULD.CMT               ║
  556.      ║                                                                    ║
  557.      ║   Archive Comment File    : C:\PKINSERT\PKINSERT.CMT               ║
  558.      ║                                                                    ║
  559.      ║   Disclaimer(s) Del List  : C:\PKINSERT\PKINSDEL.LST               ║
  560.      ║   Add File(s) List        : C:\PKINSERT\PKINSADD.LST               ║
  561.      ║                                                                    ║
  562.      ╚═══ 01/01/92 ════════════════════════════════════════ 07:10:00am ═══╝
  563.  
  564.  
  565.                                   Ascii Editor
  566.  
  567.      Ascii editor file name  and path.  Placing the  cursor on a line which
  568.      can be edited, a bar will appear at the bottom of the screen informing
  569.      you to press F2 to edit the file.
  570.  
  571.                                Standard Log File
  572.  
  573.      File name and path of the Standard log file.
  574.  
  575.      Note:    Pound (#)  signs within  text entries  are replaced  with the
  576.               current  node number  (except  in the  Tagline  field).  Node
  577.               numbers are  retrieved from  the Pcboard.Sys  and/or Door.Sys
  578.               file in  the current  directory.  If  none is  available, the
  579.               node number defaults to zero (0).
  580.  
  581.               If  you  wish to  retain  a  single configuration  file  in a
  582.               multi-user environment,  and do  not have  Pcboard.Sys and/or
  583.               Door.Sys available, you may  configure node numbers using the
  584.               (/N)ode parameter.
  585.  
  586.                         Extended Pass and Fail Log Files
  587.  
  588.      If the  'Manage Pass/Fail  Log' option  (1st configuration  screen) is
  589.      enabled, these file names are used to report processing results.
  590.  
  591.                        Virus Comment (Test) and (Upload)
  592.  
  593.      These two text files are used when PKInsert has created the Failed Log
  594.      File above and _only_ in cases when a virus is found.
  595.  
  596.      The contents  of (Test)  are added  to the  Fail log  when the (/TEST)
  597.      parameter is used.   SysOps could use  this file to  advise users they
  598.      should leave a  Comment to the  SysOp a.s.a.p. so  this archive may be
  599.  
  600.      
  601.  
  602.      PKInsert Software Documentation                          Page 10 of 16
  603.      ──────────────────────────────────────────────────────────────────────
  604.  
  605.      deleted.
  606.  
  607.      Similarly, the contents of (Upload) are added to the Fail log when the
  608.      (/UPLOAD) parameter  is used.   This second  text file  could advise a
  609.      user that  his system  might be  contaminated and  to take appropriate
  610.      steps before uploading again.
  611.  
  612.      Note:    If these files do not exist, they will not be used.  This way
  613.               you could have a comment for one function and not the other.
  614.  
  615.               PCBoard V14.5a passes these values to PCBTest.Bat as (%2).
  616.  
  617.                               Archive Comment File
  618.  
  619.      This file should contain your archive comment (Ascii drawing).  Enable
  620.      this feature from the 'Configuration Options' menu.
  621.  
  622.                              Disclaimer(s) Del List
  623.  
  624.      This list is  used when the 'Delete  Disclaimer(s)' option is enabled.
  625.      A single  filespec should be  entered on each  line.  Archive contents
  626.      will be compared to this list and matching files will be deleted.
  627.  
  628.      Note:    Unfortunately Lha also scans this file for additional command
  629.               line  arguments, therefore  you should  NOT begin  a filespec
  630.               with (-) or (/).
  631.  
  632.               PKInsert will prevent deletion of Pkzip.Exe/Pkunzip.Exe files
  633.               from original PKZip  upgrades (recognized as  a file starting
  634.               with PKZ### and ending in EXE or ZIP).  You may therefore add
  635.               Pkzip.Exe/Pkunzip.Exe to the delete list.
  636.  
  637.                                 Add File(s) List
  638.  
  639.      Same principal as above, this file  should contain a list of filespecs
  640.      to insert in every archive.  Unlike  the delete list, you must include
  641.      complete paths for each file.
  642.  
  643.      Note:    Incorrect  information  may cause  some  archivers  to behave
  644.               erratically.  Please verify that  you have entered full paths
  645.               (with drive specifier) to existing files.
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.  
  659.  
  660.      
  661.  
  662.      PKInsert Software Documentation                          Page 11 of 16
  663.      ──────────────────────────────────────────────────────────────────────
  664.  
  665.      ╔════════════════════════════════════════════════════════════════════╗
  666.      ║                    Command Line Parameters Menu                    ║
  667.      ║                                                                    ║
  668.      ║   McAfee Associates SCAN  : /a /nobreak /nomem /nopause /sub       ║
  669.      ║                                                                    ║
  670.      ║   Pkzip Del Disclaimer(s) : /bc:\ /dk                              ║
  671.      ║   Pkzip Add Files/Comment : /bc:\ /exzk                            ║
  672.      ║   Pkunzip Test Archive    : /t                                     ║
  673.      ║   Pkunzip Extract Files   : /xn /ojhsr                             ║
  674.      ║                                                                    ║
  675.      ║   Lha Del Disclaimer(s)   : d /wc:\                                ║
  676.      ║   Lha Add Files           : a /wc:\                                ║
  677.      ║   Lha Test Archive        : t /m1                                  ║
  678.      ║   Lha Extract Files       : e /m2                                  ║
  679.      ║                                                                    ║
  680.      ║   Arj Del Disclaimer(s)   : d /wc:\ /s1 /!@                        ║
  681.      ║   Arj Add Files/Comment   : a /wc:\ /s1 /!@ /m4 /e                 ║
  682.      ║   Arj Add Comment Only    : c /wc:\ /s1                            ║
  683.      ║   Arj Test Archive        : t                                      ║
  684.      ║   Arj Extract Files       : e /y                                   ║
  685.      ║                                                                    ║
  686.      ╚═══ 01/01/92 ════════════════════════════════════════ 07:10:00am ═══╝
  687.  
  688.  
  689.      These parameters are  passed by PKInsert when  shelling to third party
  690.      software.  If you encounter problems  with a new parameter set, please
  691.      drop me a line so I can adjust PKInsert accordingly.
  692.  
  693.                          Pkzip/Lha/Arj Work File Paths
  694.  
  695.      When Pkzip, Lha, or Arj handle  an archive they creates temporary work
  696.      files.  If you  have a ram-disk  installed, you should  edit the above
  697.      command line  parameters instructing  Pkzip, Lha,  and Arj  to use the
  698.      faster drive.
  699.  
  700.          ie.  Pkzip Del Disclaimer(s) : /bh:\ /dk
  701.               Pkzip Add Files/Comment : /bh:\ /exzk
  702.                                         ^^^^^
  703.               Lha Del Disclaimer(s)   : d /wh:\
  704.               Lha Add Files/Comment   : a /wh:\
  705.                                           ^^^^^
  706.               Arj Del Disclaimer(s)   : d /wh:\ /s1 /!@
  707.               Arj Add Files/Comment   : a /wh:\ /s1 /!@ /m4 /e
  708.               Arj Add Comment Only    : c /wh:\ /s1
  709.                                           ^^^^^
  710.  
  711.                                  Date Stamping
  712.  
  713.      Pkzip
  714.  
  715.          Using the default (k) parameter, will instruct Pkzip NOT to change
  716.          the file date of an archive.  An  (o) will set the archive date to
  717.          the  oldest  file  found  within  the  archive.   Eliminating this
  718.          parameter will cause the archive date to be updated to the current
  719.  
  720.      
  721.  
  722.      PKInsert Software Documentation                          Page 12 of 16
  723.      ──────────────────────────────────────────────────────────────────────
  724.  
  725.          one.
  726.  
  727.          ie.  Pkzip Del Disclaimer(s) : /bh:\ /do
  728.               Pkzip Add Files/Comment : /bh:\ /exzo
  729.                                               ^^^^^
  730.      Lha
  731.  
  732.          Lha  will  not  change  an  archive's  date  unless  an additional
  733.          parameter is used.  The (/t1)  command instructs Lha to update the
  734.          archive's date to the newest file within.
  735.  
  736.          ie.  Lha Del Disclaimer(s)   : d /wh:\ /t1
  737.               Lha Add Files/Comment   : a /wh:\ /t1
  738.                                                 ^^^
  739.      Arj
  740.  
  741.          The default switch (/s1)  will instruct Arj to  keep the same file
  742.          date  when updating  the  archive.  Eliminating  this  switch will
  743.          stamp the file with the  current system date.  Using (/s) instead,
  744.          will set the archive's date to that of the newest file within.
  745.  
  746.          ie.  Arj Del Disclaimer(s)   : d /wh:\ /s /!@
  747.               Arj Add Files/Comment   : a /wh:\ /s /!@ /m4 /e
  748.               Arj Add Comment Only    : c /wh:\ /s
  749.                                                 ^^
  750.  
  751.      Optionally you may refer to the appropriate archiver manuals to select
  752.      alternative parameters for  compression speeds/efficiency, file sorts,
  753.      filters, etc.
  754.  
  755.  
  756.  
  757.  
  758.  
  759.  
  760.  
  761.  
  762.  
  763.  
  764.  
  765.  
  766.  
  767.  
  768.  
  769.  
  770.  
  771.  
  772.  
  773.  
  774.  
  775.  
  776.  
  777.  
  778.  
  779.  
  780.      
  781.  
  782.      PKInsert Software Documentation                          Page 13 of 16
  783.      ──────────────────────────────────────────────────────────────────────
  784.  
  785.                                  Using PKInsert
  786.  
  787.      Using PKInsert is fairly simple.  From the command line or environment
  788.      variable make  sure PKInsert  knows where  to find  it's configuration
  789.      file.  Then call PKInsert passing it file names (or wildcards).
  790.  
  791.      The parameters,  file names, etc.  may be  in any order  and any valid
  792.      compression standard.   You could  even enter  file names  through the
  793.      environment variable if you wanted.  Some examples follow.
  794.  
  795.          ie.  Set PKInsert=/cD:\PKInsert\PKInsert.Cfg /s8.1V85
  796.               PKInsert.Exe Abc.Zip
  797.  
  798.               Set PKInsert=/n1 /s8.1v85
  799.               PKInsert.Exe %1 /cD:\PKInsert\PKInsert.Cfg *.Exe Abc-?.New
  800.  
  801.               Set PKInsert=/cC:\PKInsert\System.Cfg
  802.               PKInsert.Exe *.Zip *.Exe Abc.Bak New.Arj *.Lzh
  803.  
  804.               Set PKInsert=/n1 /sVer85 Archive.* /c\Arc\Config.Pki
  805.               PKInsert.Exe
  806.  
  807.               PKInsert.Exe /cThisDir.Cnf Test.Hld
  808.  
  809.      Any  filename preceded  with  an AT  (@)  symbol will  be  expected to
  810.      contain a list of  files to process.  Each  file specification in this
  811.      list  must occupy  a separate  line.  Wildcarding  is accepted  on the
  812.      command line and within file lists.
  813.  
  814.          ie.  PKInsert.Exe @*.Lst Archive.Zip
  815.  
  816.               Files.Lst
  817.               ~~~~~~~~~
  818.               D:\Arc\*.Arj
  819.               Archive.*
  820.               E:\Main\Files\Backup.B??
  821.               \Work\A*.Tmp
  822.  
  823.          You may also use a combination of directory pipes.
  824.  
  825.          ie.  C:\> Dir D:\Arc >Files.Lst
  826.               C:\> Dir E:\Main\Files\*.* >>Files.Lst
  827.  
  828.          Instead  of  entering  redundant  directory  information  you  can
  829.          instruct PKInsert to change drives  and directories.  Use the (Cd)
  830.          command  followed by  a space,  or  back-slash, and  the directory
  831.          name.
  832.  
  833.          ie.  Files.Lst
  834.               ~~~~~~~~~
  835.               Archive.Zip
  836.               Cd\Arc
  837.               Archive.Arj
  838.               Cd E:\Main\Files
  839.  
  840.      
  841.  
  842.      PKInsert Software Documentation                          Page 14 of 16
  843.      ──────────────────────────────────────────────────────────────────────
  844.  
  845.               Good*.*
  846.               Bad*.Old
  847.               Ugly*.$$$
  848.               Cd\C:\Temp
  849.               Backup.Z??
  850.  
  851.  
  852.  
  853.  
  854.  
  855.  
  856.  
  857.  
  858.  
  859.  
  860.  
  861.  
  862.  
  863.  
  864.  
  865.  
  866.  
  867.  
  868.  
  869.  
  870.  
  871.  
  872.  
  873.  
  874.  
  875.  
  876.  
  877.  
  878.  
  879.  
  880.  
  881.  
  882.  
  883.  
  884.  
  885.  
  886.  
  887.  
  888.  
  889.  
  890.  
  891.  
  892.  
  893.  
  894.  
  895.  
  896.  
  897.  
  898.  
  899.  
  900.      
  901.  
  902.      PKInsert Software Documentation                          Page 15 of 16
  903.      ──────────────────────────────────────────────────────────────────────
  904.  
  905.                                    Appendix A
  906.                               PKInsert Exit Codes
  907.  
  908.           Virus Scan
  909.  
  910.      10   One or More Virii Found
  911.      11   Abnormal Termination
  912.           (Usually Lack of Memory)
  913.  
  914.           Pkunzip
  915.  
  916.      20   Zip Failed CRC Check
  917.      21   Error in Zip File
  918.      22   Insufficient Memory
  919.      23   Archive File Missing
  920.      24   Illegal Parameters Specified
  921.      25   No Files in Archive to Test
  922.      26   Disk Full
  923.      27   Unexpected EOF in Zip
  924.  
  925.           Pkzip
  926.  
  927.      40   Bad File Name or File Specification
  928.      41   Error in Zip File
  929.      42   Insufficient Memory
  930.      43   No Files Found To Delete
  931.      44   File Not Found
  932.      45   Disk Full
  933.      46   Archive Is Read-Only - Cannot Modify
  934.      47   Bad or Illegal Parameters
  935.      48   Too Many Files in Zip
  936.  
  937.           Lha
  938.  
  939.      50  CRC Error or Insufficient Disk Space
  940.      51  Temporary Archive Write Failed
  941.  
  942.          Arj
  943.  
  944.      60  Fatal Error
  945.      61  Header or File CRC Error
  946.      62  ARJ-SECURITY Error or Attempt to Modify
  947.      63  Insufficient Disk Space or Write Error
  948.      64  Unable to Open Archive
  949.      65  Bad or Missing Parameters
  950.      66  Insufficient Memory
  951.  
  952.           PKInsert
  953.  
  954.      100  Incorrect Parameters
  955.      101  Configuration File Missing
  956.      103  Unable To Create Work Directory
  957.      104  Invalid Path or No Matching Files
  958.      105  Insufficient Drive Space Available
  959.  
  960.      
  961.  
  962.      PKInsert Software Documentation                          Page 16 of 16
  963.      ──────────────────────────────────────────────────────────────────────
  964.  
  965.      106  Unable To Remove Work Directory
  966.      107  Insufficient DOS File Handles
  967.      108  Network Delay Timed-Out
  968.      109  Unable to Remove Nest Directories
  969.      111  Illegal Compression Method Used
  970.      112  Zero Byte File
  971.      113  Unknown Configuration File Format
  972.      114  Unable to Locate File; Pkzip/Unzip or Scan
  973.  
  974.  
  975.  
  976.  
  977.  
  978.  
  979.  
  980.  
  981.  
  982.  
  983.  
  984.  
  985.  
  986.  
  987.  
  988.  
  989.  
  990.  
  991.  
  992.  
  993.  
  994.  
  995.  
  996.  
  997.  
  998.  
  999.  
  1000.  
  1001.  
  1002.  
  1003.  
  1004.  
  1005.  
  1006.  
  1007.  
  1008.  
  1009.  
  1010.  
  1011.  
  1012.  
  1013.  
  1014.  
  1015.  
  1016.  
  1017.  
  1018.  
  1019.  
  1020.      
  1021.